Overview | Package | Class | Tree | Deprecated | Index | Help			Java Platform 1.1.7
PREV CLASS | NEXT CLASS	FRAMES | NO FRAMES
SUMMARY: INNER | FIELD | CONSTR | METHOD	DETAIL: FIELD | CONSTR | METHOD

Class com.sun.java.swing.JProgressBar

java.lang.Object
  |
  +--java.awt.Component
        |
        +--java.awt.Container
              |
              +--com.sun.java.swing.JComponent
                    |
                    +--com.sun.java.swing.JProgressBar

public class JProgressBar

extends JComponent

implements SwingConstants, Accessible

A component that displays an integer value graphically within a bounded interval. A progress bar typically communicates the progress of an event by displaying its percentage of completion. The orientation of the progress bar depends on its size. If its height is greater than its width, the progress bar is vertical.

Warning: serialized objects of this class will not be compatible with future swing releases. The current serialization support is appropriate for short term storage or RMI between Swing1.0 applications. It will not be possible to load serialized Swing1.0 objects with future releases of Swing. The JDK1.2 release of Swing will be the compatibility baseline for the serialized form of Swing objects.

See Also:

Serialized Form

Inner Class Summary

	JProgressBar.AccessibleJProgressBar The class used to obtain the accessible role for this object.
	JProgressBar.ModelListener

Inner classes inherited from class com.sun.java.swing.JComponent

JComponent.AccessibleJComponent

Field Summary

BoundedRangeModel	barModel
ChangeEvent	changeEvent Only one ChangeEvent is needed per instance since the event's only interesting property is the immutable source, which is the progress bar.
ChangeListener	changeListener
int	orientation
boolean	paintBorder

Fields inherited from class com.sun.java.swing.JComponent

accessibleContext, listenerList, TOOL_TIP_TEXT_KEY, ui, UNDEFINED_CONDITION, WHEN_ANCESTOR_OF_FOCUSED_COMPONENT, WHEN_FOCUSED, WHEN_IN_FOCUSED_WINDOW

Fields inherited from class java.awt.Component

BOTTOM_ALIGNMENT, CENTER_ALIGNMENT, LEFT_ALIGNMENT, RIGHT_ALIGNMENT, TOP_ALIGNMENT

Constructor Summary

JProgressBar()
Creates a horizontal progress bar with a border.

Method Summary

void	addChangeListener(ChangeListener l) Adds a ChangeListener to the button.
ChangeListener	createChangeListener()
void	fireStateChanged() Notify all listeners that have registered interest for notification on this event type.
AccessibleContext	getAccessibleContext() Get the AccessibleContext associated with this JComponent
int	getMaximum() Returns the model's maximum value.
int	getMinimum() Returns the model's minimum value.
BoundedRangeModel	getModel() Returns the data model used by the JProgressBar.
int	getOrientation() Returns JProgressBar.
java.lang.String	getUIClassID() Returns the name of the L&F class that renders this component.
com.sun.java.swing.plaf.ProgressBarUI	getUI() Returns the L&F object that renders this component.
int	getValue() Returns the model's current value.
boolean	isBorderPainted() Returns true if the progress bar has a border or false if it does not.
void	paintBorder(java.awt.Graphics g) Paint the progress bar's border if BorderPainted property is true.
void	removeChangeListener(ChangeListener l) Removes a ChangeListener from the button.
void	setBorderPainted(boolean b) Sets whether the progress bar should have a border.
void	setMaximum(int n) Sets the model's maximum to x.
void	setMinimum(int n) Sets the model's minimum to x.
void	setModel(BoundedRangeModel newModel) Sets the data model used by the JProgressBar.
void	setOrientation(int newOrientation) Sets the progress bar's orientation to newOrientation, which must be JProgressBar.
void	setUI(com.sun.java.swing.plaf.ProgressBarUI ui) Sets the L&F object that renders this component.
void	setValue(int n) Sets the model's current value to x.
void	update(java.awt.Graphics g) Overridden to call paint without filling the background.
void	updateUI() Notification from the UIFactory that the L&F has changed.

Methods inherited from class com.sun.java.swing.JComponent

addAncestorListener, addNotify, addPropertyChangeListener, addVetoableChangeListener, computeVisibleRect, contains, createToolTip, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, firePropertyChange, fireVetoableChange, getAccessibleContext, getActionForKeyStroke, getAlignmentX, getAlignmentY, getAutoscrolls, getBorder, getBounds, getClientProperty, getComponentGraphics, getConditionForKeyStroke, getDebugGraphicsOptions, getGraphics, getHeight, getInsets, getLocation, getMaximumSize, getMinimumSize, getNextFocusableComponent, getPreferredSize, getRegisteredKeyStrokes, getRootPane, getSize, getToolTipLocation, getToolTipText, getToolTipText, getTopLevelAncestor, getUIClassID, getVisibleRect, getWidth, getX, getY, grabFocus, hasFocus, isDoubleBuffered, isFocusCycleRoot, isFocusTraversable, isLightweightComponent, isManagingFocus, isOpaque, isOptimizedDrawingEnabled, isPaintingTile, isRequestFocusEnabled, isValidateRoot, paintBorder, paintChildren, paintComponent, paintImmediately, paintImmediately, paint, processComponentKeyEvent, processFocusEvent, processKeyEvent, processMouseMotionEvent, putClientProperty, registerKeyboardAction, registerKeyboardAction, removeAncestorListener, removeNotify, removePropertyChangeListener, removeVetoableChangeListener, repaint, repaint, requestDefaultFocus, requestFocus, resetKeyboardActions, reshape, revalidate, scrollRectToVisible, setAlignmentX, setAlignmentY, setAutoscrolls, setBorder, setBounds, setDebugGraphicsOptions, setDoubleBuffered, setMaximumSize, setMinimumSize, setNextFocusableComponent, setOpaque, setPreferredSize, setRequestFocusEnabled, setToolTipText, setUI, setVisible, unregisterKeyboardAction, update, updateUI

Methods inherited from class java.awt.Container

add, add, add, add, add, addContainerListener, addImpl, addNotify, countComponents, deliverEvent, doLayout, findComponentAt, findComponentAt, getAlignmentX, getAlignmentY, getComponentAt, getComponentAt, getComponent, getComponentCount, getComponents, getInsets, getLayout, getMaximumSize, getMinimumSize, getPreferredSize, insets, invalidate, isAncestorOf, layout, list, list, locate, minimumSize, paintComponents, paint, paramString, preferredSize, printComponents, print, processContainerEvent, processEvent, removeAll, remove, remove, removeContainerListener, removeNotify, setLayout, update, validate, validateTree

Methods inherited from class java.awt.Component

action, add, addComponentListener, addFocusListener, addInputMethodListener, addKeyListener, addMouseListener, addMouseMotionListener, addNotify, addPropertyChangeListener, addPropertyChangeListener, bounds, checkImage, checkImage, coalesceEvents, contains, contains, createImage, createImage, deliverEvent, disable, disableEvents, dispatchEvent, doLayout, enable, enable, enableEvents, enableInputMethods, firePropertyChange, getAlignmentX, getAlignmentY, getBackground, getBounds, getBounds, getColorModel, getComponentAt, getComponentAt, getComponentOrientation, getCursor, getDropTarget, getFont, getFontMetrics, getForeground, getGraphics, getHeight, getInputContext, getInputMethodRequests, getLocale, getLocation, getLocation, getLocationOnScreen, getMaximumSize, getMinimumSize, getName, getParent, getPeer, getPreferredSize, getSize, getSize, getToolkit, getTreeLock, getWidth, getX, getY, gotFocus, handleEvent, hasFocus, hide, imageUpdate, inside, invalidate, isDisplayable, isDoubleBuffered, isEnabled, isFocusTraversable, isLightweight, isOpaque, isShowing, isValid, isVisible, keyDown, keyUp, layout, list, list, list, list, list, locate, location, lostFocus, minimumSize, mouseDown, mouseDrag, mouseEnter, mouseExit, mouseMove, mouseUp, move, nextFocus, paintAll, paint, paramString, postEvent, preferredSize, prepareImage, prepareImage, printAll, print, processComponentEvent, processEvent, processFocusEvent, processInputMethodEvent, processKeyEvent, processMouseEvent, processMouseMotionEvent, remove, removeComponentListener, removeFocusListener, removeInputMethodListener, removeKeyListener, removeMouseListener, removeMouseMotionListener, removeNotify, removePropertyChangeListener, removePropertyChangeListener, repaint, repaint, repaint, repaint, requestFocus, reshape, resize, resize, setBackground, setBounds, setBounds, setComponentOrientation, setCursor, setDropTarget, setEnabled, setFont, setForeground, setLocale, setLocation, setLocation, setName, setSize, setSize, setVisible, show, show, size, toString, transferFocus, update, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notifyAll, notify, toString, wait, wait, wait

Field Detail

orientation

protected int orientation

paintBorder

protected boolean paintBorder

barModel

protected BoundedRangeModel barModel

changeEvent

protected transient ChangeEvent changeEvent

Only one ChangeEvent is needed per instance since the event's only interesting property is the immutable source, which is the progress bar.

changeListener

protected ChangeListener changeListener

Constructor Detail

JProgressBar

public JProgressBar()

Creates a horizontal progress bar with a border.

Method Detail

update

public void update(java.awt.Graphics g)

Overridden to call paint without filling the background.

Overrides:

update in class JComponent

getOrientation

public int getOrientation()

Returns JProgressBar.VERTICAL or JProgressBar.HORIZONTAL, depending on the orientation of the progress bar. The default orientation is HORIZONTAL.

Returns:

HORIZONTAL or VERTICAL

setOrientation

public void setOrientation(int newOrientation)

Sets the progress bar's orientation to newOrientation, which must be JProgressBar.VERTICAL or JProgressBar.HORIZONTAL. The default orientation is HORIZONTAL.

Parameters:

newOrientation - HORIZONTAL or VERTICAL

Throws:

java.lang.IllegalArgumentException - if newOrientation is an illegal value

isBorderPainted

public boolean isBorderPainted()

Returns true if the progress bar has a border or false if it does not.

Returns:

whether the progress bar has a border

See Also:

setBorderPainted

setBorderPainted

public void setBorderPainted(boolean b)

Sets whether the progress bar should have a border.

Parameters:

b - true if the progress bar should have a border

See Also:

isBorderPainted

paintBorder

protected void paintBorder(java.awt.Graphics g)

Paint the progress bar's border if BorderPainted property is true.

Parameters:

g - the Graphics context within which to paint the border

Overrides:

paintBorder in class JComponent

See Also:

paint, setBorder

getUI

public com.sun.java.swing.plaf.ProgressBarUI getUI()

Returns the L&F object that renders this component.

Returns:

the ProgressBarUI object that renders this component

setUI

public void setUI(com.sun.java.swing.plaf.ProgressBarUI ui)

Sets the L&F object that renders this component.

Parameters:

ui - the ProgressBarUI L&F object

See Also:

getUI

updateUI

public void updateUI()

Notification from the UIFactory that the L&F has changed. Called to replace the UI with the latest version from the UIFactory.

Overrides:

updateUI in class JComponent

See Also:

updateUI

getUIClassID

public java.lang.String getUIClassID()

Returns the name of the L&F class that renders this component.

Returns:

"ProgressBarUI"

Overrides:

getUIClassID in class JComponent

See Also:

getUIClassID, getUI

createChangeListener

protected ChangeListener createChangeListener()

addChangeListener

public void addChangeListener(ChangeListener l)

Adds a ChangeListener to the button.

Parameters:

l - the ChangeListener to add

removeChangeListener

public void removeChangeListener(ChangeListener l)

Removes a ChangeListener from the button.

Parameters:

l - the ChangeListener to remove

fireStateChanged

protected void fireStateChanged()

Notify all listeners that have registered interest for notification on this event type. The event instance is lazily created using the parameters passed into the fire method.

See Also:

EventListenerList

getModel

public BoundedRangeModel getModel()

Returns the data model used by the JProgressBar.

Returns:

the BoundedRangeModel currently in use

See Also:

BoundedRangeModel

setModel

public void setModel(BoundedRangeModel newModel)

Sets the data model used by the JProgressBar.

Parameters:

newModel - the BoundedRangeModel to use

See Also:

BoundedRangeModel

getValue

public int getValue()

Returns the model's current value. The value is always between the model's minimum and maximum values, inclusive.

Returns:

the value

See Also:

setValue, BoundedRangeModel

getMinimum

public int getMinimum()

Returns the model's minimum value.

Returns:

an int -- the model's minimum

See Also:

setMinimum, BoundedRangeModel

getMaximum

public int getMaximum()

Returns the model's maximum value.

Returns:

an int -- the model's maximum

See Also:

setMaximum, BoundedRangeModel

setValue

public void setValue(int n)

Sets the model's current value to x. If x is less than the minimum or greater than the maximum, this method throws an IllegalArgumentException and the value is not changed.

Notifies any listeners if the data changes.

Parameters:

x - the new value

See Also:

getValue, BoundedRangeModel

setMinimum

public void setMinimum(int n)

Sets the model's minimum to x. If the maximum value or current value is outside of the new minimum, the maximum or current value is adjusted accordingly.

Notifies any listeners if the data changes.

Parameters:

x - the new minimum

See Also:

getMinimum, addChangeListener, BoundedRangeModel

setMaximum

public void setMaximum(int n)

Sets the model's maximum to x. If the minimum value or current value is outside of the new maximum, the minimum or current value is adjusted accordingly.

Notifies any listeners if the data changes.

Parameters:

x - the new maximum

See Also:

getMaximum, addChangeListener, BoundedRangeModel

getAccessibleContext

public AccessibleContext getAccessibleContext()

Get the AccessibleContext associated with this JComponent

Specified by:

getAccessibleContext in interface Accessible

Returns:

the AccessibleContext of this JComponent

Overrides:

getAccessibleContext in class JComponent